DOC-1896 Document feature RPCN Improve troubleshooting#535
DOC-1896 Document feature RPCN Improve troubleshooting#535
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThis pull request updates documentation across four AsciiDoc files to reflect changes in the Redpanda Connect quickstart user interface. The primary change modifies connect-quickstart.adoc to instruct users to directly edit pipeline YAML in the editor rather than use a wizard-based approach. Additional updates normalize terminology across related docs by replacing "wizard" references with "guide" where appropriate and removing references to automatic configuration generation during setup. Configuration and secret management guidance is adjusted accordingly. Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@modules/develop/pages/connect/connect-quickstart.adoc`:
- Line 78: The sentence lists two connectors (`generate` input connector and
`redpanda` output connector) but then uses singular "this connector"; change the
reference to plural (e.g., replace "this connector" with "these connectors" or
rephrase to "the YAML for the connectors appears in the editor") so the subject
and pronoun agree with `generate` and `redpanda`.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 2a7ab292-e275-4453-a192-e6cad25fa8ab
📒 Files selected for processing (4)
modules/develop/pages/connect/connect-quickstart.adocmodules/get-started/pages/whats-new-cloud.adocmodules/get-started/partials/cloud-quickstart.adocmodules/get-started/partials/get-started-serverless.adoc
|
@micheleRP Who is the eng SME for this one? |
| . **Add permissions**: Create a new user called `connect`. Leave the rest of the default settings. The user will be created with the necessary permissions. Click **Next**. | ||
|
|
||
| . **Edit pipeline**: | ||
| .. Enter this name for the pipeline: `joke-generator-producer`. | ||
| .. The **Configuration** section automatically populates the YAML with your selected components. Under *Connectors*, you can add the processors `log` and `catch` to log generated jokes and monitor for errors. However, for simplicity in this quickstart, replace the entire configuration with the following YAML, which includes the processors and the `mapping` for joke generation: |
There was a problem hiding this comment.
oh, I ended up tweaking this a bit, where we now open a dialog that shows the same "add topic" and "add user" steps like we previously did. both are skippable, and we can still have this onboarding doc recommend that they can configure both via the slash menu or command menu.. but worth calling out that if a user selects a "redpanda" input or output from the Connectors picker, we will then launch a dialog that let's them configure topics and users, and it will populate the yaml for them based on their selection.
There was a problem hiding this comment.
another thing worth noting. you have to perform 2 separate flows to add an input and output. I'll record a demo in a moment, but tldr:
- in the left pane click the
+button next to the placeholder input. - in the connector picker dialog select "generate" connector (dialog will close and you'll see a template in the yaml editor)
- replace the config witih the yaml
- in the left pane click the
+button next to the placeholder output - in the connector picker dialog select "redpanda" connector. this will open a different dialog which includes both the "add a topic" and "add permissions" steps we know from the old wizard
- create a
dad-jokestopic - create a user
- yaml editor will now include a
redpandaoutput with topic and sasl already configured.
3 participants
Description
This pull request updates the Redpanda Connect quickstart documentation to reflect recent UI and workflow changes, focusing on a more streamlined experience using the YAML editor and slash commands. It also updates related references throughout the documentation to match the new terminology and user flow.
Redpanda Connect Quickstart and UI Workflow Updates:
/) to insert variables, secrets, topics, and users, rather than using a step-by-step wizard.Resolves https://redpandadata.atlassian.net/browse/DOC-1896
Review deadline:
Page previews
Redpanda Connect Quickstart
Serverless - Interact with your cluster
What's New (update to original listing)
Checks